Update Retailer Ship-To Location

curl --request PUT \
  --url https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "DC-001",
  "qualifier": "gln",
  "label": "Bentonville DC",
  "location_type": "dc",
  "company": "Walmart DC",
  "street": "<string>",
  "city": "Bentonville",
  "region_id": 6,
  "region": "AR",
  "postcode": "72712",
  "country_id": "US",
  "telephone": "+1-479-273-4000",
  "email": "dc6045@example.com",
  "is_default": true,
  "status": "active"
}
'

import requests

url = "https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id}"

payload = {
    "code": "DC-001",
    "qualifier": "gln",
    "label": "Bentonville DC",
    "location_type": "dc",
    "company": "Walmart DC",
    "street": "<string>",
    "city": "Bentonville",
    "region_id": 6,
    "region": "AR",
    "postcode": "72712",
    "country_id": "US",
    "telephone": "+1-479-273-4000",
    "email": "dc6045@example.com",
    "is_default": True,
    "status": "active"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: 'DC-001',
    qualifier: 'gln',
    label: 'Bentonville DC',
    location_type: 'dc',
    company: 'Walmart DC',
    street: '<string>',
    city: 'Bentonville',
    region_id: 6,
    region: 'AR',
    postcode: '72712',
    country_id: 'US',
    telephone: '+1-479-273-4000',
    email: 'dc6045@example.com',
    is_default: true,
    status: 'active'
  })
};

fetch('https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => 'DC-001',
    'qualifier' => 'gln',
    'label' => 'Bentonville DC',
    'location_type' => 'dc',
    'company' => 'Walmart DC',
    'street' => '<string>',
    'city' => 'Bentonville',
    'region_id' => 6,
    'region' => 'AR',
    'postcode' => '72712',
    'country_id' => 'US',
    'telephone' => '+1-479-273-4000',
    'email' => 'dc6045@example.com',
    'is_default' => true,
    'status' => 'active'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id}"

	payload := strings.NewReader("{\n  \"code\": \"DC-001\",\n  \"qualifier\": \"gln\",\n  \"label\": \"Bentonville DC\",\n  \"location_type\": \"dc\",\n  \"company\": \"Walmart DC\",\n  \"street\": \"<string>\",\n  \"city\": \"Bentonville\",\n  \"region_id\": 6,\n  \"region\": \"AR\",\n  \"postcode\": \"72712\",\n  \"country_id\": \"US\",\n  \"telephone\": \"+1-479-273-4000\",\n  \"email\": \"dc6045@example.com\",\n  \"is_default\": true,\n  \"status\": \"active\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"DC-001\",\n  \"qualifier\": \"gln\",\n  \"label\": \"Bentonville DC\",\n  \"location_type\": \"dc\",\n  \"company\": \"Walmart DC\",\n  \"street\": \"<string>\",\n  \"city\": \"Bentonville\",\n  \"region_id\": 6,\n  \"region\": \"AR\",\n  \"postcode\": \"72712\",\n  \"country_id\": \"US\",\n  \"telephone\": \"+1-479-273-4000\",\n  \"email\": \"dc6045@example.com\",\n  \"is_default\": true,\n  \"status\": \"active\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"DC-001\",\n  \"qualifier\": \"gln\",\n  \"label\": \"Bentonville DC\",\n  \"location_type\": \"dc\",\n  \"company\": \"Walmart DC\",\n  \"street\": \"<string>\",\n  \"city\": \"Bentonville\",\n  \"region_id\": 6,\n  \"region\": \"AR\",\n  \"postcode\": \"72712\",\n  \"country_id\": \"US\",\n  \"telephone\": \"+1-479-273-4000\",\n  \"email\": \"dc6045@example.com\",\n  \"is_default\": true,\n  \"status\": \"active\"\n}"

response = http.request(request)
puts response.read_body

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid.",
      "details": [
        {
          "key": "hold_until_date",
          "message": "The date must be in the future."
        }
      ]
    }
  ]
}

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

{
  "errors": [
    {
      "type": "unable_to_process",
      "message": "The supplied parameters are invalid.",
      "details": [
        {
          "key": "hold_until_date",
          "message": "The date must be in the future."
        }
      ]
    }
  ]
}

PUT

shipping

retailers

{id}

ship-to-locations

{location_id}

Update Retailer Ship-To Location

curl --request PUT \
  --url https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "DC-001",
  "qualifier": "gln",
  "label": "Bentonville DC",
  "location_type": "dc",
  "company": "Walmart DC",
  "street": "<string>",
  "city": "Bentonville",
  "region_id": 6,
  "region": "AR",
  "postcode": "72712",
  "country_id": "US",
  "telephone": "+1-479-273-4000",
  "email": "dc6045@example.com",
  "is_default": true,
  "status": "active"
}
'

import requests

url = "https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id}"

payload = {
    "code": "DC-001",
    "qualifier": "gln",
    "label": "Bentonville DC",
    "location_type": "dc",
    "company": "Walmart DC",
    "street": "<string>",
    "city": "Bentonville",
    "region_id": 6,
    "region": "AR",
    "postcode": "72712",
    "country_id": "US",
    "telephone": "+1-479-273-4000",
    "email": "dc6045@example.com",
    "is_default": True,
    "status": "active"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: 'DC-001',
    qualifier: 'gln',
    label: 'Bentonville DC',
    location_type: 'dc',
    company: 'Walmart DC',
    street: '<string>',
    city: 'Bentonville',
    region_id: 6,
    region: 'AR',
    postcode: '72712',
    country_id: 'US',
    telephone: '+1-479-273-4000',
    email: 'dc6045@example.com',
    is_default: true,
    status: 'active'
  })
};

fetch('https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => 'DC-001',
    'qualifier' => 'gln',
    'label' => 'Bentonville DC',
    'location_type' => 'dc',
    'company' => 'Walmart DC',
    'street' => '<string>',
    'city' => 'Bentonville',
    'region_id' => 6,
    'region' => 'AR',
    'postcode' => '72712',
    'country_id' => 'US',
    'telephone' => '+1-479-273-4000',
    'email' => 'dc6045@example.com',
    'is_default' => true,
    'status' => 'active'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id}"

	payload := strings.NewReader("{\n  \"code\": \"DC-001\",\n  \"qualifier\": \"gln\",\n  \"label\": \"Bentonville DC\",\n  \"location_type\": \"dc\",\n  \"company\": \"Walmart DC\",\n  \"street\": \"<string>\",\n  \"city\": \"Bentonville\",\n  \"region_id\": 6,\n  \"region\": \"AR\",\n  \"postcode\": \"72712\",\n  \"country_id\": \"US\",\n  \"telephone\": \"+1-479-273-4000\",\n  \"email\": \"dc6045@example.com\",\n  \"is_default\": true,\n  \"status\": \"active\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"DC-001\",\n  \"qualifier\": \"gln\",\n  \"label\": \"Bentonville DC\",\n  \"location_type\": \"dc\",\n  \"company\": \"Walmart DC\",\n  \"street\": \"<string>\",\n  \"city\": \"Bentonville\",\n  \"region_id\": 6,\n  \"region\": \"AR\",\n  \"postcode\": \"72712\",\n  \"country_id\": \"US\",\n  \"telephone\": \"+1-479-273-4000\",\n  \"email\": \"dc6045@example.com\",\n  \"is_default\": true,\n  \"status\": \"active\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"DC-001\",\n  \"qualifier\": \"gln\",\n  \"label\": \"Bentonville DC\",\n  \"location_type\": \"dc\",\n  \"company\": \"Walmart DC\",\n  \"street\": \"<string>\",\n  \"city\": \"Bentonville\",\n  \"region_id\": 6,\n  \"region\": \"AR\",\n  \"postcode\": \"72712\",\n  \"country_id\": \"US\",\n  \"telephone\": \"+1-479-273-4000\",\n  \"email\": \"dc6045@example.com\",\n  \"is_default\": true,\n  \"status\": \"active\"\n}"

response = http.request(request)
puts response.read_body

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid.",
      "details": [
        {
          "key": "hold_until_date",
          "message": "The date must be in the future."
        }
      ]
    }
  ]
}

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

{
  "errors": [
    {
      "type": "unable_to_process",
      "message": "The supplied parameters are invalid.",
      "details": [
        {
          "key": "hold_until_date",
          "message": "The date must be in the future."
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

integer<int32>

required

The id of the parent Retailer.

Required range: x >= 1

location_id

integer<int32>

required

The id of the referenced RetailerShipToLocation.

Required range: x >= 1

Body

application/json

An object conforming to the RetailerShipToLocation schema to be merged.

A RetailerShipToLocation represents an EDI N1*ST destination (distribution center, store, drop-ship, or other) under a Retailer.

code

string

required

Unique location code within the parent Retailer + merchant.

Required string length: 1 - 64

Example:

"DC-001"

qualifier

enum<string>

required

The canonical scheme that identifies the location code (EDI qualifiers are normalized to this set).

Available options:

duns,

duns_plus_4,

gln,

buyer_location,

seller_location,

third_party_location,

plant_code,

dodaac,

cage,

dea,

hin,

san,

approver_id,

clli,

census_schedule_d,

census_schedule_k

Example:

"gln"

label

string | null

Optional display label.

Maximum string length: 255

Example:

"Bentonville DC"

location_type

enum<string>

default:dc

Location type.

Available options:

dc,

store,

drop_ship,

other

Example:

"dc"

company

string | null

Optional company name.
Optional Field

Maximum string length: 255

Example:

"Walmart DC"

street

string | null

Optional street address; may contain newlines.
Optional Field

city

string | null

Optional city.
Optional Field

Maximum string length: 255

Example:

"Bentonville"

region_id

integer<int32> | null

Optional Magento directory_country_region id. Reserved for future integration.
Optional Field

Example:

6

region

string | null

Optional free-form region (state/province).
Optional Field

Maximum string length: 255

Example:

"AR"

postcode

string | null

Optional postal code.
Optional Field

Maximum string length: 32

Example:

"72712"

country_id

string | null

Optional two-letter ISO country code. Normalized to uppercase by the server.
Optional Field

Maximum string length: 2

Example:

"US"

telephone

string | null

Optional telephone number.
Optional Field

Maximum string length: 32

Example:

"+1-479-273-4000"

string<email> | null

Optional email address.
Optional Field

Maximum string length: 255

Example:

"dc6045@example.com"

is_default

boolean

default:false

When true on save, sibling default locations under the same Retailer are atomically unset.

Example:

true

status

enum<string>

default:active

Location lifecycle status.

Available options:

active,

inactive

Example:

"active"

retailer

RetailerRef · object

Parent Retailer reference. Set from the path; cannot be changed.

Show child attributes

Response

OK - The operation completed successfully and there is no response body.

Get Started

Common Features

Inventory API v1

Receiving API v1

Shipping API v1

System API v1

Update Retailer Ship-To Location

Authorizations

Path Parameters

Body

Response